Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove couch usage & generate archives instead #21

Merged
merged 19 commits into from
Mar 15, 2017
Merged

Remove couch usage & generate archives instead #21

merged 19 commits into from
Mar 15, 2017

Conversation

sivakumar-kailasam
Copy link
Member

@sivakumar-kailasam sivakumar-kailasam commented Mar 3, 2017

  • Remove pouch

  • Generate archive

  • Updated dependencies

  • Change the way docs are processed so that we don't need lot of memory.

  • Sync the generated directory before and after the tool processes docs so that we do incremental generation. This will help for the directory to be synced in the ember-app

  • Deployment strategy

  • Travis changes

  • There are hardcoded links in some docs' description leading to broken links in the api viewer. We should handle their rewrites here.

  • Some file names refer to other low levels like inflector & rsvp through node_modules folder. Instead of constructing the github url in the ember app, we can generate full file urls by keeping the mapping to their repos here and handling these cases

@toddjordan
Copy link
Contributor

I would prefer to break the files up into the directory structure discussed in the issue, something like project/version/type/name, like ember/2.11.2/class/Ember.Component.json

@sivakumar-kailasam
Copy link
Member Author

sivakumar-kailasam commented Mar 5, 2017

Great timing, I was just rewriting the logic to follow this structure to map 1:1 to the app's url

- Ability to pass project name and/or version to index
- Reorganized the logic so that we process one version of a doc at a
time, ensuring that we don't need lot of memory
@fivetanley
Copy link
Contributor

I am extremely stoked for this!!

@fivetanley
Copy link
Contributor

@sivakumar-kailasam @toddjordan How can I help get this over the finish line?

* master:
  split module class attribute into public/private classes
@sivakumar-kailasam
Copy link
Member Author

sivakumar-kailasam commented Mar 15, 2017

@fivetanley FIxing the hardcoded links in descriptions & updating the file urls with functional full form github urls are tasks atomic enough to be done on either this or the master branch. I've created #24 & #25 with the details

@toddjordan
Copy link
Contributor

@fivetanley we are trying to get as much done as we can before emberconf and we have a variety of tasks based on you your level of interest :-)
Check out the todos in our project: https://github.com/ember-learn/ember-api-docs/projects/1
Feel free to pick up anything. Just lmk ❤️

@sivakumar-kailasam sivakumar-kailasam changed the title [WIP] Remove couch usage & generate archives instead Remove couch usage & generate archives instead Mar 15, 2017
@toddjordan toddjordan merged commit d8c217d into ember-learn:master Mar 15, 2017
@sivakumar-kailasam sivakumar-kailasam deleted the drop-pouch-couch branch March 15, 2017 19:47
@sivakumar-kailasam
Copy link
Member Author

Fixes #22 , #18, #17, #7

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants